<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Struct bmqt::CompressionAlgorithmType</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="bdedox.css" rel="stylesheet" type="text/css"/>
    <style>
      div.hanging {
        padding-left: 0.75in;
        text-indent: -0.50in;
      }
      div.unhanging {
        text-indent:     0in;
      }
      a.glossary {
        font-weight: bold;
        font-style: italic;
      }
    </style>
</head>
<!--
<body onload='searchBox.OnSelectItem(0);'>
-->
<body>

<table border=2 cellspacing=0 cellpadding=0 align=center>
<tr>
 <td valign=top align=center>
 <p align=center><b><i>Quick Links:</i></b></p>
 </td>
 <td valign=top align=center>
 <p align=center>
<a class="qindex" href="group__bmqa.html" target="_blank">bmqa</a> | <a class="qindex" href="group__bmqpi.html" target="_blank">bmqpi</a> | <a class="qindex" href="group__bmqt.html" target="_blank">bmqt</a>
 </td>
 </tr>
 </table>

  </div>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul class="tablist">
      <li><a href="components.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="components.html"><span>Components</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath">
    <ul>
      <li><a class="el" href="namespacebmqt.html">bmqt</a>      </li>
      <li><a class="el" href="structbmqt_1_1CompressionAlgorithmType.html">bmqt::CompressionAlgorithmType</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a>  </div>
  <div class="headertitle">
<h1>bmqt::CompressionAlgorithmType Struct Reference</h1>  </div>
</div>
<div class="contents">
<!-- doxytag: class="bmqt::CompressionAlgorithmType" -->
<p><code>#include &lt;<a class="el" href="bmqt__compressionalgorithmtype_8h_source.html">bmqt_compressionalgorithmtype.h</a>&gt;</code></p>

<p><a href="structbmqt_1_1CompressionAlgorithmType-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbmqt_1_1CompressionAlgorithmType.html#ac557e5b9a25ddb9e0efd87ec921ebb03">Enum</a> { <a class="el" href="structbmqt_1_1CompressionAlgorithmType.html#ac557e5b9a25ddb9e0efd87ec921ebb03ac5f538180e33d99ddb8b45f812c651f7">e_UNKNOWN</a> =  -1, 
<a class="el" href="structbmqt_1_1CompressionAlgorithmType.html#ac557e5b9a25ddb9e0efd87ec921ebb03a29561bc3514989a9187f324ef94eb541">e_NONE</a> =  0, 
<a class="el" href="structbmqt_1_1CompressionAlgorithmType.html#ac557e5b9a25ddb9e0efd87ec921ebb03a50c25b8c9c8ceb1b463984eff301f951">e_ZLIB</a> =  1
 }</td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static bsl::ostream &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbmqt_1_1CompressionAlgorithmType.html#a3f0bd20e419a4be860d21e0a009315ec">print</a> (bsl::ostream &amp;stream, <a class="el" href="structbmqt_1_1CompressionAlgorithmType.html#ac557e5b9a25ddb9e0efd87ec921ebb03">CompressionAlgorithmType::Enum</a> value, int level=0, int spacesPerLevel=4)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbmqt_1_1CompressionAlgorithmType.html#a8809cd51d4f40a1e3f846d263f20da82">toAscii</a> (<a class="el" href="structbmqt_1_1CompressionAlgorithmType.html#ac557e5b9a25ddb9e0efd87ec921ebb03">CompressionAlgorithmType::Enum</a> value)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbmqt_1_1CompressionAlgorithmType.html#a69413ba9c032c8bd39c106f08313738a">fromAscii</a> (<a class="el" href="structbmqt_1_1CompressionAlgorithmType.html#ac557e5b9a25ddb9e0efd87ec921ebb03">CompressionAlgorithmType::Enum</a> *out, const bsl::string &amp;str)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbmqt_1_1CompressionAlgorithmType.html#a2644147da81d923b97698dc46084f5c5">isValid</a> (const bsl::string *str, bsl::ostream &amp;stream)</td></tr>
<tr><td colspan="2"><h2><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbmqt_1_1CompressionAlgorithmType.html#a323cb58a60cae60f02b890ddaa103ba3">k_LOWEST_SUPPORTED_TYPE</a> = e_NONE</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbmqt_1_1CompressionAlgorithmType.html#a9bd5ab7c0a9c3c02915ef128ac264145">k_HIGHEST_SUPPORTED_TYPE</a> = e_ZLIB</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This struct defines various types of compression algorithms.</p>
<p>See <a class="el" href="group__bmqt__compressionalgorithmtype.html">Component bmqt_compressionalgorithmtype</a> </p>
<hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="ac557e5b9a25ddb9e0efd87ec921ebb03"></a><!-- doxytag: member="bmqt::CompressionAlgorithmType::Enum" ref="ac557e5b9a25ddb9e0efd87ec921ebb03" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="structbmqt_1_1CompressionAlgorithmType.html#ac557e5b9a25ddb9e0efd87ec921ebb03">bmqt::CompressionAlgorithmType::Enum</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="ac557e5b9a25ddb9e0efd87ec921ebb03ac5f538180e33d99ddb8b45f812c651f7"></a><!-- doxytag: member="e_UNKNOWN" ref="ac557e5b9a25ddb9e0efd87ec921ebb03ac5f538180e33d99ddb8b45f812c651f7" args="" -->e_UNKNOWN</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ac557e5b9a25ddb9e0efd87ec921ebb03a29561bc3514989a9187f324ef94eb541"></a><!-- doxytag: member="e_NONE" ref="ac557e5b9a25ddb9e0efd87ec921ebb03a29561bc3514989a9187f324ef94eb541" args="" -->e_NONE</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ac557e5b9a25ddb9e0efd87ec921ebb03a50c25b8c9c8ceb1b463984eff301f951"></a><!-- doxytag: member="e_ZLIB" ref="ac557e5b9a25ddb9e0efd87ec921ebb03a50c25b8c9c8ceb1b463984eff301f951" args="" -->e_ZLIB</em>&nbsp;</td><td>
</td></tr>
</table>
</dd>
</dl>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a3f0bd20e419a4be860d21e0a009315ec"></a><!-- doxytag: member="bmqt::CompressionAlgorithmType::print" ref="a3f0bd20e419a4be860d21e0a009315ec" args="(bsl::ostream &amp;stream, CompressionAlgorithmType::Enum value, int level=0, int spacesPerLevel=4)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static bsl::ostream&amp; bmqt::CompressionAlgorithmType::print </td>
          <td>(</td>
          <td class="paramtype">bsl::ostream &amp;&nbsp;</td>
          <td class="paramname"> <em>stream</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structbmqt_1_1CompressionAlgorithmType.html#ac557e5b9a25ddb9e0efd87ec921ebb03">CompressionAlgorithmType::Enum</a>&nbsp;</td>
          <td class="paramname"> <em>value</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>level</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>spacesPerLevel</em> = <code>4</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Write the string representation of the specified enumeration <code>value</code> to the specified output <code>stream</code>, and return a reference to <code>stream</code>. Optionally specify an initial indentation <code>level</code>, whose absolute value is incremented recursively for nested objects. If <code>level</code> is specified, optionally specify <code>spacesPerLevel</code>, whose absolute value indicates the number of spaces per indentation level for this and all of its nested objects. If <code>level</code> is negative, suppress indentation of the first line. If <code>spacesPerLevel</code> is negative, format the entire output on one line, suppressing all but the initial indentation (as governed by <code>level</code>). See <code>toAscii</code> for what constitutes the string representation of a <code><a class="el" href="structbmqt_1_1CompressionAlgorithmType.html#ac557e5b9a25ddb9e0efd87ec921ebb03">CompressionAlgorithmType::Enum</a></code> value. </p>

</div>
</div>
<a class="anchor" id="a8809cd51d4f40a1e3f846d263f20da82"></a><!-- doxytag: member="bmqt::CompressionAlgorithmType::toAscii" ref="a8809cd51d4f40a1e3f846d263f20da82" args="(CompressionAlgorithmType::Enum value)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static const char* bmqt::CompressionAlgorithmType::toAscii </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structbmqt_1_1CompressionAlgorithmType.html#ac557e5b9a25ddb9e0efd87ec921ebb03">CompressionAlgorithmType::Enum</a>&nbsp;</td>
          <td class="paramname"> <em>value</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Return the non-modifiable string representation corresponding to the specified enumeration <code>value</code>, if it exists, and a unique (error) string otherwise. The string representation of <code>value</code> matches its corresponding enumerator name with the "e_" prefix eluded. For example: </p>
<div class="fragment"><pre class="fragment">          bsl::cout &lt;&lt; <a class="code" href="structbmqt_1_1CompressionAlgorithmType.html#a8809cd51d4f40a1e3f846d263f20da82">CompressionAlgorithmType::toAscii</a>(
                                      <a class="code" href="structbmqt_1_1CompressionAlgorithmType.html#ac557e5b9a25ddb9e0efd87ec921ebb03a29561bc3514989a9187f324ef94eb541">CompressionAlgorithmType::e_NONE</a>);
</pre></div><p> will print the following on standard output: </p>
<div class="fragment"><pre class="fragment">          NONE
</pre></div><p> Note that specifying a <code>value</code> that does not match any of the enumerators will result in a string representation that is distinct from any of those corresponding to the enumerators, but is otherwise unspecified. </p>

</div>
</div>
<a class="anchor" id="a69413ba9c032c8bd39c106f08313738a"></a><!-- doxytag: member="bmqt::CompressionAlgorithmType::fromAscii" ref="a69413ba9c032c8bd39c106f08313738a" args="(CompressionAlgorithmType::Enum *out, const bsl::string &amp;str)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static bool bmqt::CompressionAlgorithmType::fromAscii </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structbmqt_1_1CompressionAlgorithmType.html#ac557e5b9a25ddb9e0efd87ec921ebb03">CompressionAlgorithmType::Enum</a> *&nbsp;</td>
          <td class="paramname"> <em>out</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const bsl::string &amp;&nbsp;</td>
          <td class="paramname"> <em>str</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Update the specified <code>out</code> with correct enum corresponding to the specified string <code>str</code>, if it exists, and return true. Otherwise in case of an error or unidentified string, return false. The expected <code>str</code> is the enumerator name with the "e_" prefix excluded. For example: </p>
<div class="fragment"><pre class="fragment">          <a class="code" href="structbmqt_1_1CompressionAlgorithmType.html#a69413ba9c032c8bd39c106f08313738a">CompressionAlgorithmType::fromAscii</a>(out, NONE);
</pre></div><p> will return true and the value of <code>out</code> will be: </p>
<div class="fragment"><pre class="fragment">          bmqt::CompresssionAlgorithmType::e_NONE
</pre></div><p> Note that specifying a <code>str</code> that does not match any of the enumerators excluding "e_" prefix will result in the function returning false and the specified <code>out</code> will not be touched. </p>

</div>
</div>
<a class="anchor" id="a2644147da81d923b97698dc46084f5c5"></a><!-- doxytag: member="bmqt::CompressionAlgorithmType::isValid" ref="a2644147da81d923b97698dc46084f5c5" args="(const bsl::string *str, bsl::ostream &amp;stream)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static bool bmqt::CompressionAlgorithmType::isValid </td>
          <td>(</td>
          <td class="paramtype">const bsl::string *&nbsp;</td>
          <td class="paramname"> <em>str</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bsl::ostream &amp;&nbsp;</td>
          <td class="paramname"> <em>stream</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Return true incase of valid specified <code>str</code> i.e. a enumerator name with the "e_" prefix excluded. Otherwise in case of invalid <code>str</code> return false and populate the specified <code>stream</code> with error message. </p>

</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a323cb58a60cae60f02b890ddaa103ba3"></a><!-- doxytag: member="bmqt::CompressionAlgorithmType::k_LOWEST_SUPPORTED_TYPE" ref="a323cb58a60cae60f02b890ddaa103ba3" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const int <a class="el" href="structbmqt_1_1CompressionAlgorithmType.html#a323cb58a60cae60f02b890ddaa103ba3">bmqt::CompressionAlgorithmType::k_LOWEST_SUPPORTED_TYPE</a> = e_NONE<code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a9bd5ab7c0a9c3c02915ef128ac264145"></a><!-- doxytag: member="bmqt::CompressionAlgorithmType::k_HIGHEST_SUPPORTED_TYPE" ref="a9bd5ab7c0a9c3c02915ef128ac264145" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const int <a class="el" href="structbmqt_1_1CompressionAlgorithmType.html#a9bd5ab7c0a9c3c02915ef128ac264145">bmqt::CompressionAlgorithmType::k_HIGHEST_SUPPORTED_TYPE</a> = e_ZLIB<code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="bmqt__compressionalgorithmtype_8h_source.html">bmqt_compressionalgorithmtype.h</a></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Thu Jun 15 2023 11:58:51 by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>
